All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.accessibility.AccessibleComponent

public interface AccessibleComponent
The AccessibleComponent interface should be supported by any object that is rendered on the screen. This interface provides the standard mechanism for an assistive technology to determine and set the graphical representation of an object. Applications can determine if an object supports the AccessibleComponent interface by first obtaining its AccessibleContext (see Accessible) and then calling the getAccessibleComponent method of AccessibleContext. If the return value is not null, the object supports this interface.

See Also:
Accessible, getAccessibleContext, AccessibleContext, getAccessibleComponent

Method Index

 o addFocusListener(FocusListener)
Adds the specified focus listener to receive focus events from this component.
 o contains(Point)
Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.
 o getAccessibleAt(Point)
Returns the Accessible child, if one exists, contained at the local coordinate Point.
 o getBackground()
Get the background color of this object.
 o getBounds()
Gets the bounds of this object in the form of a Rectangle object.
 o getCursor()
Get the Cursor of this object.
 o getFont()
Get the Font of this object.
 o getFontMetrics(Font)
Get the FontMetrics of this object.
 o getForeground()
Get the foreground color of this object.
 o getLocation()
Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.
 o getLocationOnScreen()
Returns the location of the object on the screen.
 o getSize()
Returns the size of this object in the form of a Dimension object.
 o isEnabled()
Determine if the object is enabled.
 o isFocusTraversable()
Returns whether this object can accept focus or not.
 o isShowing()
Determine if the object is showing.
 o isVisible()
Determine if the object is visible.
 o removeFocusListener(FocusListener)
Removes the specified focus listener so it no longer receives focus events from this component.
 o requestFocus()
Requests focus for this object.
 o setBackground(Color)
Set the background color of this object.
 o setBounds(Rectangle)
Sets the bounds of this object in the form of a Rectangle object.
 o setCursor(Cursor)
Set the Cursor of this object.
 o setEnabled(boolean)
Set the enabled state of the object.
 o setFont(Font)
Set the Font of this object.
 o setForeground(Color)
Set the foreground color of this object.
 o setLocation(Point)
Sets the location of the object relative to the parent.
 o setSize(Dimension)
Resizes this object so that it has width and height.
 o setVisible(boolean)
Set the visible state of the object.

Methods

 o getBackground
 public abstract Color getBackground()
Get the background color of this object.

Returns:
the background color, if supported, of the object; otherwise, null
See Also:
setBackground
 o setBackground
 public abstract void setBackground(Color c)
Set the background color of this object.

Parameters:
c - the new Color for the background
See Also:
setBackground
 o getForeground
 public abstract Color getForeground()
Get the foreground color of this object.

Returns:
the foreground color, if supported, of the object; otherwise, null
See Also:
setForeground
 o setForeground
 public abstract void setForeground(Color c)
Set the foreground color of this object.

Parameters:
c - the new Color for the foreground
See Also:
getForeground
 o getCursor
 public abstract Cursor getCursor()
Get the Cursor of this object.

Returns:
the Cursor, if supported, of the object; otherwise, null
See Also:
setCursor
 o setCursor
 public abstract void setCursor(Cursor cursor)
Set the Cursor of this object.

Parameters:
c - the new Cursor for the object
See Also:
getCursor
 o getFont
 public abstract Font getFont()
Get the Font of this object.

Returns:
the Font,if supported, for the object; otherwise, null
See Also:
setFont
 o setFont
 public abstract void setFont(Font f)
Set the Font of this object.

Parameters:
f - the new Font for the object
See Also:
getFont
 o getFontMetrics
 public abstract FontMetrics getFontMetrics(Font f)
Get the FontMetrics of this object.

Parameters:
f - the Font
Returns:
the FontMetrics, if supported, the object; otherwise, null
See Also:
getFont
 o isEnabled
 public abstract boolean isEnabled()
Determine if the object is enabled. Objects that are enabled will also have the AccessibleState.ENABLED state set in their AccessibleStateSet.

Returns:
true if object is enabled; otherwise, false
See Also:
setEnabled, getAccessibleStateSet, ENABLED, AccessibleStateSet
 o setEnabled
 public abstract void setEnabled(boolean b)
Set the enabled state of the object.

Parameters:
b - if true, enables this object; otherwise, disables it
See Also:
isEnabled
 o isVisible
 public abstract boolean isVisible()
Determine if the object is visible. Note: this means that the object intends to be visible; however, it may not be showing on the screen because one of the objects that this object is contained by is currently not visible. To determine if an object is showing on the screen, use isShowing().

Objects that are visible will also have the AccessibleState.VISIBLE state set in their AccessibleStateSet.

Returns:
true if object is visible; otherwise, false
See Also:
setVisible, getAccessibleStateSet, VISIBLE, AccessibleStateSet
 o setVisible
 public abstract void setVisible(boolean b)
Set the visible state of the object.

Parameters:
b - if true, shows this object; otherwise, hides it
See Also:
isVisible
 o isShowing
 public abstract boolean isShowing()
Determine if the object is showing. This is determined by checking the visibility of the object and visibility of the object ancestors. Note: this will return true even if the object is obscured by another (for example, it to object is underneath a menu that was pulled down).

Returns:
true if object is showing; otherwise, false
 o contains
 public abstract boolean contains(Point p)
Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.

Parameters:
p - the Point relative to the coordinate system of the object
Returns:
true if object contains Point; otherwise false
See Also:
getBounds
 o getLocationOnScreen
 public abstract Point getLocationOnScreen()
Returns the location of the object on the screen.

Returns:
location of object on screen; null if this object is not on the screen
See Also:
getBounds, getLocation
 o getLocation
 public abstract Point getLocation()
Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.

Returns:
An instance of Point representing the top-left corner of the objects's bounds in the coordinate space of the screen; null if this object or its parent are not on the screen
See Also:
getBounds, getLocationOnScreen
 o setLocation
 public abstract void setLocation(Point p)
Sets the location of the object relative to the parent.

Parameters:
p - the new position for the top-left corner
See Also:
getLocation
 o getBounds
 public abstract Rectangle getBounds()
Gets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Returns:
A rectangle indicating this component's bounds; null if this object is not on the screen.
See Also:
contains
 o setBounds
 public abstract void setBounds(Rectangle r)
Sets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Parameters:
r - rectangle indicating this component's bounds
See Also:
getBounds
 o getSize
 public abstract Dimension getSize()
Returns the size of this object in the form of a Dimension object. The height field of the Dimension object contains this objects's height, and the width field of the Dimension object contains this object's width.

Returns:
A Dimension object that indicates the size of this component; null if this object is not on the screen
See Also:
setSize
 o setSize
 public abstract void setSize(Dimension d)
Resizes this object so that it has width and height.

Parameters:
d - - The dimension specifying the new size of the object.
See Also:
getSize
 o getAccessibleAt
 public abstract Accessible getAccessibleAt(Point p)
Returns the Accessible child, if one exists, contained at the local coordinate Point.

Parameters:
p - The point relative to the coordinate system of this object.
Returns:
the Accessible, if it exists, at the specified location; otherwise null
 o isFocusTraversable
 public abstract boolean isFocusTraversable()
Returns whether this object can accept focus or not. Objects that can accept focus will also have the AccessibleState.FOCUSABLE state set in their AccessibleStateSet.

Returns:
true if object can accept focus; otherwise false
See Also:
getAccessibleStateSet, FOCUSABLE, FOCUSED, AccessibleStateSet
 o requestFocus
 public abstract void requestFocus()
Requests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.

See Also:
isFocusTraversable
 o addFocusListener
 public abstract void addFocusListener(FocusListener l)
Adds the specified focus listener to receive focus events from this component.

Parameters:
l - the focus listener
See Also:
removeFocusListener
 o removeFocusListener
 public abstract void removeFocusListener(FocusListener l)
Removes the specified focus listener so it no longer receives focus events from this component.

Parameters:
l - the focus listener
See Also:
addFocusListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index